Macro Shortcuts by Mario Collado
Version 1.0
Licence: Freeware
Compatible with Macro5 and Assistant only!

Please read this document carefully. It contains important informations about Installation, usage, special features of and navigation in this macro!
----------------------------------------------------------------------------------
I often read about people complaining, that Macro5 isn't supported anymore and is not compatible with the new machines like Revo or Osaris.
Also, many users of Assistant asked me to implement Shortcut panels in Assistant, like available in Macro5.

So I decided, to write this Macro, which is fully compatible with both Macro5 and Assistant.

It will work with all  EPOC Machines like Series5 classic, 5mx (pro), Netbook/S7, Revo (plus), Diamond Mako and the Osaris.

On the Netbook/S7 it will run with full color support.

Compatibility with Macro5:
Macro5 works on all machines, though the Shortcut panels of it are adapted to the Screen size of the Series5 range.
On a Revo or Osaris, the panels will not fit on the smaller screen.
Also, on a Netbook/S7, the panels do not have full color support.
With this Macro, it is possible to use Macro5 on this machines by using this Macro instead of the "real" panels of macro5.

Installation:
-------------
Unzip the respective Archive for your machine and copy both files
Shortcuts.opo and Shortcuts*.mbm to your Macro folder.
(for the Netbook/S7/S5 version: Shortcuts5.mbm is the Black and white version, ShortcutsC.mbm the colour version. On a Greyscale machine, you can savely delete the coloured version and vice versa)

In both Assistant and Macro5, make sure, you have defined in the main menu the Macro folder, otherwise, the macro will not work properly!
To define your Macro folder:
In both programs use "Macro folder" (Ctrl-f) in the main menu.

Now, assign a "User defined Hotkey" to the macro.
In both programs use "Hotkeys">"Userdefined" (Ctrl-u),
select a free one and use "Edit". Enter a caption, use "type" "Macro", select the Macro by navigating in the file dialog to your Macro folder and select Shortcuts.opo.
In the following dialog, assign a Hotkey for it and you are done.

Macro5 users:
Instead of calling in Macro5 the normal panels, always call the panels of the Macro instead, by pressing the juest defined Hotkey.

The first time you call the Macro, it could take a while (especially on a 5 classic), as the panels have to be created as well as the ini file.
Further calling of the Macro is pretty fast. To make this possible, in C:\System\Data\ you will find, that the following files are created:
SC1.tmp, SC2.tmp, SC3.tmp and Shortcuts.ini

What it does:
----------------

The Macro will give you three panels of 28 Shortcuts (A-Z, Space and point)
On a Osaris, there are only the letters A-Y
Makes 3=25=75 Shortcuts on an Osaris or 3*28=84 Shortcuts on any other machine.
Shortcuts can be linked to:
Programs, Documents, Macros, Cliptexts, Folders and Keystrokes
The look of the panels is like the Extrasbar.
You will see for any Shortcut the caption you entered for it, as well as its icon.

Defining a Shortcut:

Tap on a empty Shortcut or press its assigned letter or Enter, to bring up the edit dialog for it.
Enter a caption, which will be shown under the icon and select the type.

Program: can be any of the installed Applications or opo's
(The file selector will point to the System\Apps\ folder, just select the program folder of the App you like to assign and select the *.app)

Document: can be any document, which has the same icon as its program, like Word,Sheet....
In Assistant, you can use any valid file, you can open also normally with Assistant, like mbm's, txt, zips, html (if the respective program is installed)
In Macro5, you will get a "not supported" message, when trying to assign here a file, which is opened by regognizers such as mbm's etc.

Macro: any Macro5 macro, the file selector will initially point to the macros folder, but you can select also a macro, which is located in any other folder.

Folder: Select any folder on your System

Cliptext: Enter your text, which will be pasted later to your documents (You can use also special definitions like %%date%% etc., see the Helpfile of the programs)

Keystroke: enter the key to be sent to the underlying application, after the Shortcut is selected.


Navigation:
-------------
Menu:  Show the menu

Pen:
pen without modifier: execute Shortcut and close the macro
Ctrl-pen: Edit the tapped Shortcut
Shift-Ctrl-pen: Move Shortcut
Fn-pen: Delete Shortcut
Shift-pen: execute Shortcut and continue (do not close) the macro
(practical, to run more programs/documents in one go)

keyboard:
A-Z, Space, point (".") : Execute the respective Shortcut or edit an empty one
Shift-Letter (A-Z): execute Shortcut and stay on top (see above)
Delete, Ctrl-d : delete Shortcut (after selecting the respective letter)
Enter, Ctrl-u: Edit/update Shortcut (after selecting the respective letter)
Ctrl-x: Move Shortcut (to either another position or another table. Just select old and new position as well as the respective panel)
Ctrl-q: Show a quick help on Navigation keys
Ctrl-e, Esc: close the Macro
Ctrl-r: redraw screen (in case, some rests of captions or icons remained on screen after moving or deleting of a Shortcut, which should not happen normally)
Ctrl-Shift-c: Change icon of the Shortcut (see later)
Tab, Shift-Tab, 1,2,3, Cursors, tapping on the buttons left of the screen: Move between the tables

Icons:
-------
The macro supports the standard ways of displaying icons for a Shortcut like in Macro5:
Programs will be shown with its program icon like in the Extrasbar
Documents will be shown with its Application icon like in the system screen.
Folder Shortcuts will show the symbol of a folder
Keystroke Shortcuts as well as Cliptexts and Macros will be shown with standard icons

If for a Macro a *.ico file with the same name exists in either the Macros folder or a folder \Icons\ in the Macro folder, the macro will be shown on the panel with the content of this one instead of the standard symbol.
*.ico files are standard mbm files, which must contain a bitmap and a mask, both sized at 48*48 pixel (32*32 on a Revo or Osaris)

If for a Cliptext, keystroke or folder a *.ico file exists in the Macro folder+\Icons\, which has the same name as the CAPTION of the  Shortcut, it will be shown with this icon instead.
If for a document a *.ico file exists either in the same folder as the document itself or the Icons\ folder within the Macro folder, and has the same name as the document+".ico",  this icon will be displayed instead.

Too complicated? :-)
Select Shift-Ctrl-c
Select from the options: Standard, Application icon, File
Standard: Select any of the supplied standard icons for the Shortcut
Aplication icon: Select an icon of any installed program on your machine (just move with cursor right and left, press ESC to cancel, Enter to select)
File: Select any valid file, which must contain: (only)2 Bitmaps (Bitmap and mask), both sized 48*48 or 32*32 (Revo/Osaris) pixel
The file can be located anywhere on your system and can be used also for more than one Shortcut.

If you select the option Change icon, the icon will override any existing *.ico files, which may exist for macros or any other type, so this icon will be displayed with this Shortcut, until you change the icon again or delete the Shortcut.


Future plans:
----------------
None, if I get no feedback ;-)
If I get enough feedback, I will:
implement this feature fix in Assistant, which will speed up things
Add more types of Shortcuts, like URL's, Conversions or Assistant functions, which can be reached faster that way

Disclaimer:
-------------
Use this Macro on your own risk! I can not guarantee, that this software is error free! This software is free for personal use.

Contact:
----------
email: Collado@gmx.net
Web: http://www.psionwelt.de/MarioCollado


